API

System APIs

PUT system/error-messages/{errorMessageId}

Saves an error-message.

HTTP method PUT
URI https://api.rambase.net/system/error-messages/{errorMessageId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {errorMessageId} Error message identifier
Integer, minimum 1
Successful HTTP status code 202
API resource identifier 165, version 6

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
<ErrorMessage
ErrorMessage

This field is optional.

>
2
     <Status
Status

Object status of the errormessage

This field is optional.

>{String}</Status>
3
     <HttpStatusCode
HttpStatusCode

The HTTP Status Code that will be used when sending out the error-message (ex. 500, 404)

This field is optional.

>{Integer}</HttpStatusCode>
4
     <Message
Message

The english error-message

This field is optional.

>{String}</Message>
5
     <Namespace
Namespace

Namespace of the error message. Used for categorization only.

This field is optional.

>{String}</Namespace>
6
     <TechnicalDescription
TechnicalDescription

A techinical description describing causes of the error and solutions to the problem

This field is optional.

>{String}</TechnicalDescription>
7
</ErrorMessage>
1
{
2
     "errorMessage
ErrorMessage

This field is optional.

": {
3
          "status
Status

Object status of the errormessage

This field is optional.

": "{String}",
4
          "httpStatusCode
HttpStatusCode

The HTTP Status Code that will be used when sending out the error-message (ex. 500, 404)

This field is optional.

": "{Integer}",
5
          "message
Message

The english error-message

This field is optional.

": "{String}",
6
          "namespace
Namespace

Namespace of the error message. Used for categorization only.

This field is optional.

": "{String}",
7
          "technicalDescription
TechnicalDescription

A techinical description describing causes of the error and solutions to the problem

This field is optional.

": "{String}"
8
     }
9
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
1

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 100036 HTTP 400 Missing required input parameter: {0}
Error 100021 HTTP 400 The input value {0} has illegal value {1}, please use one of {2}
Error 100620 HTTP 400 Message is required
Error 100037 HTTP 400 Message is required when language is specified
Error 100038 HTTP 400 Invalid language: {0}